Class com.symantec.itools.vcafe.openapi.options.EnvironmentDisplayOptions 
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.symantec.itools.vcafe.openapi.options.EnvironmentDisplayOptions 

Object
   |
   +----com.symantec.itools.vcafe.openapi.options.EnvironmentDisplayOptions
public abstract class EnvironmentDisplayOptions
extends Object
The API used to represent and access the display-related options of the Visual Cafe environment. These options that appear in the "Display" tab in the Environment Options dialog.

Use EnvironmentOptionSet.getDisplayOptions() to get an instance of this object.

Version:
1.0
Author:
Symantec Internet Tools Division
Since:
VCafe 3.0
See Also:
getEnvironmentOptionSet, getDisplayOptions

Variable Index

o CATEGORY_SOURCE_CODE
Indicates display option pertains to source code windows.

Constructor Index

o com.symantec.itools.vcafe.openapi.options.EnvironmentDisplayOptions()

Method Index

o getCommentsForegroundColor()
Gets the foreground Color of comment text in source code windows.
o getCurrentLineForegroundColor()
Gets the foreground Color of current line text in source code windows.
o getCustomKeywordsForegroundColor()
Gets the foreground Color of custom keyword text in source code windows.
o getErrorsForegroundColor()
Gets the foreground Color of error text in source code windows.
o getExecutionLineBackgroundColor()
Gets the foreground Color of current execution line text in source code windows.
o getExecutionLineForegroundColor()
Gets the foreground Color of current execution line text in source code windows.
o getFont(String)
Gets the name of the font used in the specified type of window.
o getFontSize(String)
Gets the size of the font used in the specified type of window.
o getKeywordsForegroundColor()
Gets the foreground Color of keyword text in source code windows.
o getSelectedTextBackgroundColor(String)
Gets the background Color of selected text in the specified type of window.
o getSelectedTextForegroundColor(String)
Gets the foreground Color of selected text in the specified type of window.
o getTextBackgroundColor(String)
Gets the background Color of text in the specified type of window.
o getTextForegroundColor(String)
Gets the foreground Color of text in the specified type of window.
o isCommentsBold()
Determines whether comment text in source code windows is bold.
o isCommentsItalic()
Determines whether comment text in source code windows is italic.
o isCurrentLineBold()
Determines whether current line text in source code windows is bold.
o isCurrentLineItalic()
Determines whether current line text in source code windows is italic.
o isCustomKeywordsBold()
Determines whether custom keyword text in source code windows is bold.
o isCustomKeywordsItalic()
Determines whether custom keyword text in source code windows is italic.
o isKeywordsBold()
Determines whether keyword text in source code windows is bold.
o isKeywordsItalic()
Determines whether keyword text in source code windows is italic.
o isTextBold(String)
Determines whether text is bold in the specified type of window.
o isTextItalic(String)
Determines whether text is italic in the specified type of window.

Variables

o CATEGORY_SOURCE_CODE 
public static final java.lang.String CATEGORY_SOURCE_CODE
Indicates display option pertains to source code windows.

Note: currently, access is only provided for options that apply to Source code windows.

See Also:
getFont, getFontSize, getTextForegroundColor, getTextBackgroundColor, isTextBold, isTextItalic, getSelectedTextForegroundColor, getSelectedTextBackgroundColor

Constructors

o EnvironmentDisplayOptions 
public EnvironmentDisplayOptions()

Methods

o getCommentsForegroundColor 
public abstract java.awt.Color getCommentsForegroundColor()
Gets the foreground Color of comment text in source code windows.

Returns:
the comment text foreground Color.
See Also:
isCommentsBold, isCommentsItalic
o getCurrentLineForegroundColor 
public abstract java.awt.Color getCurrentLineForegroundColor()
Gets the foreground Color of current line text in source code windows.

Returns:
the current line text foreground Color.
See Also:
isCurrentLineBold, isCurrentLineItalic
o getCustomKeywordsForegroundColor 
public abstract java.awt.Color getCustomKeywordsForegroundColor()
Gets the foreground Color of custom keyword text in source code windows.

Returns:
the custom keyword text foreground Color.
See Also:
isCustomKeywordsBold, isCustomKeywordsItalic
o getErrorsForegroundColor 
public abstract java.awt.Color getErrorsForegroundColor()
Gets the foreground Color of error text in source code windows.

Returns:
the error text foreground Color.
o getExecutionLineBackgroundColor 
public abstract java.awt.Color getExecutionLineBackgroundColor()
Gets the foreground Color of current execution line text in source code windows.

Returns:
the current execution line text foreground Color.
See Also:
getExecutionLineForegroundColor
o getExecutionLineForegroundColor 
public abstract java.awt.Color getExecutionLineForegroundColor()
Gets the foreground Color of current execution line text in source code windows.

Returns:
the current execution line text foreground Color.
See Also:
getExecutionLineBackgroundColor
o getFont 
public abstract java.lang.String getFont(String category)
Gets the name of the font used in the specified type of window.

Parameters:
category - the display element category (currently only CATEGORY_SOURCE_CODE supported).
Returns:
the font name.
o getFontSize 
public abstract int getFontSize(String category)
Gets the size of the font used in the specified type of window.

Parameters:
category - the display element category (currently only CATEGORY_SOURCE_CODE supported).
Returns:
the font size.
o getKeywordsForegroundColor 
public abstract java.awt.Color getKeywordsForegroundColor()
Gets the foreground Color of keyword text in source code windows.

Returns:
the keyword text foreground Color.
See Also:
isKeywordsBold, isKeywordsItalic
o getSelectedTextBackgroundColor 
public abstract java.awt.Color getSelectedTextBackgroundColor(String category)
Gets the background Color of selected text in the specified type of window.

Parameters:
category - the display element category (currently only CATEGORY_SOURCE_CODE supported).
Returns:
the background Color of selected text.
o getSelectedTextForegroundColor 
public abstract java.awt.Color getSelectedTextForegroundColor(String category)
Gets the foreground Color of selected text in the specified type of window.

Parameters:
category - the display element category (currently only CATEGORY_SOURCE_CODE supported).
Returns:
the foreground Color of selected text.
o getTextBackgroundColor 
public abstract java.awt.Color getTextBackgroundColor(String category)
Gets the background Color of text in the specified type of window.

Parameters:
category - the display element category (currently only CATEGORY_SOURCE_CODE supported).
Returns:
the text background Color.
o getTextForegroundColor 
public abstract java.awt.Color getTextForegroundColor(String category)
Gets the foreground Color of text in the specified type of window.

Parameters:
category - the display element category (currently only CATEGORY_SOURCE_CODE supported).
Returns:
the text foreground Color.
o isCommentsBold 
public abstract boolean isCommentsBold()
Determines whether comment text in source code windows is bold.

Returns:
true if comment text is bold, false otherwise.
See Also:
getCommentsForegroundColor, isCommentsItalic
o isCommentsItalic 
public abstract boolean isCommentsItalic()
Determines whether comment text in source code windows is italic.

Returns:
true if comment text is italic, false otherwise.
See Also:
getCommentsForegroundColor, isCommentsBold
o isCurrentLineBold 
public abstract boolean isCurrentLineBold()
Determines whether current line text in source code windows is bold.

Returns:
true if current line text is bold, false otherwise.
See Also:
getCurrentLineForegroundColor, isCurrentLineItalic
o isCurrentLineItalic 
public abstract boolean isCurrentLineItalic()
Determines whether current line text in source code windows is italic.

Returns:
true if current line text is italic, false otherwise.
See Also:
getCurrentLineForegroundColor, isCurrentLineBold
o isCustomKeywordsBold 
public abstract boolean isCustomKeywordsBold()
Determines whether custom keyword text in source code windows is bold.

Returns:
true if custom keyword text is bold, false otherwise.
See Also:
getCustomKeywordsForegroundColor, isCustomKeywordsItalic
o isCustomKeywordsItalic 
public abstract boolean isCustomKeywordsItalic()
Determines whether custom keyword text in source code windows is italic.

Returns:
true if custom keyword text is italic, false otherwise.
See Also:
getCustomKeywordsForegroundColor, isCustomKeywordsBold
o isKeywordsBold 
public abstract boolean isKeywordsBold()
Determines whether keyword text in source code windows is bold.

Returns:
true if keyword text is bold, false otherwise.
See Also:
getKeywordsForegroundColor, isKeywordsItalic
o isKeywordsItalic 
public abstract boolean isKeywordsItalic()
Determines whether keyword text in source code windows is italic.

Returns:
true if keyword text is italic, false otherwise.
See Also:
getKeywordsForegroundColor, isKeywordsBold
o isTextBold 
public abstract boolean isTextBold(String category)
Determines whether text is bold in the specified type of window.

Parameters:
category - the display element category (currently only CATEGORY_SOURCE_CODE supported).
Returns:
true if the text is bold, false otherwise.
o isTextItalic 
public abstract boolean isTextItalic(String category)
Determines whether text is italic in the specified type of window.

Parameters:
category - the display element category (currently only CATEGORY_SOURCE_CODE supported).
Returns:
true if the text is italic, false otherwise. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index